Move documentation to inline comments: GtkTextMark

diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 8bc887a70a63baba995a08108f3095ebb1a8d051..4e2564dd7162727b20f371e9f4faab99224ec9a7 100644 (file)
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -110,6 +110,7 @@ gtktable.sgml
 gtktearoffmenuitem.sgml
 gtktesting.sgml
 gtktextiter.sgml
+gtktextmark.sgml
 gtktexttag.sgml
 gtktexttagtable.sgml
 gtktextview.sgml

diff --git a/docs/reference/gtk/tmpl/gtktextmark.sgml b/docs/reference/gtk/tmpl/gtktextmark.sgml
deleted file mode 100644 (file)
index a15b762..0000000
--- a/docs/reference/gtk/tmpl/gtktextmark.sgml
+++ /dev/null
@@ -1,141 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkTextMark
-
-<!-- ##### SECTION Short_Description ##### -->
-
-A position in the buffer preserved across buffer modifications
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-You may wish to begin by reading the <link linkend="TextWidget">text widget
-conceptual overview</link> which gives an overview of all the objects and data
-types related to the text widget and how they work together.
-</para>
-
-<para>
-A #GtkTextMark is like a bookmark in a text buffer; it preserves a position in
-the text. You can convert the mark to an iterator using
-gtk_text_buffer_get_iter_at_mark(). Unlike iterators, marks remain valid across
-buffer mutations, because their behavior is defined when text is inserted or
-deleted. When text containing a mark is deleted, the mark remains in the
-position originally occupied by the deleted text. When text is inserted at a
-mark, a mark with <firstterm>left gravity</firstterm> will be moved to the
-beginning of the newly-inserted text, and a mark with <firstterm>right
-gravity</firstterm> will be moved to the end. 
-
-<footnote>
-<para>
-"left" and "right" here refer to logical direction (left is the toward the start
-of the buffer); in some languages such as Hebrew the logically-leftmost text is
-not actually on the left when displayed.
-</para>
-</footnote>
-</para>
-
-<para>
-Marks are reference counted, but the reference count only controls the validity
-of the memory; marks can be deleted from the buffer at any time with
-gtk_text_buffer_delete_mark(). Once deleted from the buffer, a mark is
-essentially useless.
-</para>
-
-<para>
-Marks optionally have names; these can be convenient to avoid passing the 
-#GtkTextMark object around.
-</para>
-
-<para>
-Marks are typically created using the gtk_text_buffer_create_mark() function.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkTextMark ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GtkTextMark:left-gravity ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkTextMark:name ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_text_mark_new ##### -->
-<para>
-
-</para>
-
-@name: 
-@left_gravity: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_text_mark_set_visible ##### -->
-<para>
-
-</para>
-
-@mark: 
-@setting: 
-
-
-<!-- ##### FUNCTION gtk_text_mark_get_visible ##### -->
-<para>
-
-</para>
-
-@mark: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_text_mark_get_deleted ##### -->
-<para>
-
-</para>
-
-@mark: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_text_mark_get_name ##### -->
-<para>
-
-</para>
-
-@mark: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_text_mark_get_buffer ##### -->
-<para>
-
-</para>
-
-@mark: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_text_mark_get_left_gravity ##### -->
-<para>
-
-</para>
-
-@mark: 
-@Returns: 
-
-

diff --git a/gtk/gtktextmark.c b/gtk/gtktextmark.c
index b9fb6377fd88467e7a28ee4d1ec2522b56e1c1dc..33b0649a6f66f050b9e73b03b07ec16bb38b4efc 100644 (file)
--- a/gtk/gtktextmark.c
+++ b/gtk/gtktextmark.c
@@ -54,6 +54,43 @@
 #include "gtkintl.h"
 
 
+/**
+ * SECTION:gtktextmark
+ * @Short_description: A position in the buffer preserved across buffer modifications
+ * @Title: GtkTextMark
+ *
+ * You may wish to begin by reading the <link linkend="TextWidget">text widget
+ * conceptual overview</link> which gives an overview of all the objects and data
+ * types related to the text widget and how they work together.
+ *
+ * A #GtkTextMark is like a bookmark in a text buffer; it preserves a position in
+ * the text. You can convert the mark to an iterator using
+ * gtk_text_buffer_get_iter_at_mark(). Unlike iterators, marks remain valid across
+ * buffer mutations, because their behavior is defined when text is inserted or
+ * deleted. When text containing a mark is deleted, the mark remains in the
+ * position originally occupied by the deleted text. When text is inserted at a
+ * mark, a mark with <firstterm>left gravity</firstterm> will be moved to the
+ * beginning of the newly-inserted text, and a mark with <firstterm>right
+ * gravity</firstterm> will be moved to the end.
+ *
+ * <footnote>
+ * "left" and "right" here refer to logical direction (left is the toward the start
+ * of the buffer); in some languages such as Hebrew the logically-leftmost text is
+ * not actually on the left when displayed.
+ * </footnote>
+ *
+ * Marks are reference counted, but the reference count only controls the validity
+ * of the memory; marks can be deleted from the buffer at any time with
+ * gtk_text_buffer_delete_mark(). Once deleted from the buffer, a mark is
+ * essentially useless.
+ *
+ * Marks optionally have names; these can be convenient to avoid passing the
+ * #GtkTextMark object around.
+ *
+ * Marks are typically created using the gtk_text_buffer_create_mark() function.
+ */
+
+
 static void gtk_text_mark_set_property (GObject         *object,
                                        guint            prop_id,
                                        const GValue    *value,